package com.zenchn.config;

import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;


/**
 *Swagger2 组件 注册配置
 * @author panbingqi
 * @date 2021-06-01
 */
@Configuration
@ConditionalOnProperty(prefix = "custom.swagger",value = {"enable"},havingValue = "true")
@EnableSwagger2
public class Swagger2Config {

    /**
     * swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //为当前包路径
                .apis(RequestHandlerSelectors.basePackage("com.zenchn.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 构建 api文档的详细信息函数,注意这里的注解引用的是哪个
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title("安全监测及预警管理平台--web管理平台 RESTful API")
                //创建人
                .contact(new Contact("dingxinfa", "http://www.baidu.com", "dingxinfa@zenchn.com"))
                //版本号
                .version("1.0")
                //描述
                .description("安全监测及预警管理平台 web管理平台 RESTful API")
                .build();
    }
}
